Docker Compose 配置项学习

安装 Docker Compose

通过 apt 安装（一般不用）

sudo apt-get install docker-compose

# 测试是否安装成功
docker-compose --version

注意：上面那种版本会很低，，，

参考官网的安装方法

# 版本选择 https://github.com/docker/compose/releases
sudo curl -L "https://github.com/docker/compose/releases/download/v2.18.1/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose

sudo chmod +x /usr/local/bin/docker-compose

# 如果遇到找不到这个文件的错误，重启一下这个 Session
docker-compose --version

Docker Compose 是什

用于对 Docker 容器集群的管理，可以通过 yml 文件来配置服务（就是用来批量运行并管理多个容器的工具）

Docker Compose 将所管理的容器分为三层，分别是工程（Project）、服务（Service）以及容器（Container），在 Docker Compose 运行目录下的所有文件组成一个工程（一般工程名就是目录名），一个工程可以有多个服务，每个服务中定义了容器运行的镜像、参数、依赖，而一个服务中可包括多个容器实例

默认的模板文件名称为 docker-compose.yml，格式为 YAML 格式

version: "3"

services:
  webapp:
    image: examples/web
    ports:
      - "80:80"
    volumes:
      - "/data"

注意每个服务都必须通过 image 指令指定镜像或 build 指令（需要 Dockerfile）等来自动构建生成镜像。如果使用 build 指令，在 Dockerfile 中设置的选项（例如：CMD、EXPOSE、VOLUME、ENV 等）将会自动被获取，无需在 docker-compose.yml 中重复设置。

Compose 常用命令

注意，要到 docker-compose.yml 文件的目录下执行以下命令

# docker-compose 启动， -d 是丢到后台运行（守护式容器）
docker-compose up -d

# 查看容器
docker-compose ps

# 暂停容器
docker-compose stop

# 删除容器
docker-compose down

# 查看网络
docker network ls

模板文件示例

参考资料命令说明

# 创建文件夹（/usr/ 目录需要权限，懒得弄那么麻烦）
mkdir -p /home/alsritter/mycompose

# 进入文件夹
cd /home/alsritter/mycompose

# 创建 docker-compose.yml 文件
touch docker-compose.yml

# 然后使用 vscode 编辑（使用的是 wsl2，别忘记管理员权限打开）
code .

默认的模板文件名称为 docker-compose.yml

# yaml 配置实例
version: '3'
# services 指定服务的名称
services:  
    redis1:    
        image: redis    
        ports:      
            - "6379:6379"    
        container_name: "redis1"    
        networks:      
            - dev  
    mysql1:    
        image: mysql 
        environment:            
            MYSQL_ROOT_PASSWORD: "root"    
        ports:      
            - "3306:3306"    
        container_name: "mysql1"    
        networks:      
            - dev
    web1:    
        image: tomcat    
        ports:      
            - "9090:8080"    
        container_name: "web1"    
        # 这个 networks 是应用的网络，在它下面可以定义应用的名称、使用的网络类型等
        networks:      
            - dev      
            - pro
# 注意这个 networks 就是上面的 networks 具体配置（-dev），上面标识的 -dev 表示它处于 dev 这个网络中（看下图）
# 不同网络之间不可以互相访问
# bridge 桥接模式
networks:  
    dev:
        driver: bridge  
    pro:    
        driver: bridge

取消开机自启

如原先已启动，更新 docker-compose.yml 配置后，使修改生效，可执行：

docker-compose restart

常用的指令

build 指定构建文件

指定 Dockerfile 所在文件夹的路径（可以是绝对路径，或者相对 docker-compose.yml 文件的路径）。 Compose 将会利用它自动构建这个镜像，然后使用这个镜像。

version: '3'
services:

  webapp:
    build: ./dir

也可以使用 context 指令指定 Dockerfile 所在文件夹的路径。

使用 dockerfile 指令指定 Dockerfile 文件名。

使用 arg 指令指定构建镜像时的变量

version: '3'
services:

  webapp:
    build:
      context: ./dir
      dockerfile: Dockerfile-alternate
      args:
        buildno: 1

使用 cache_from 指定构建镜像的缓存

build:
  context: .
  cache_from:
    - alpine:latest
    - corp/web_app:3.14

image 指定镜像

指定为镜像名称或镜像 ID。如果镜像在本地不存在，Compose 将会尝试拉取这个镜像。

image: ubuntu
image: orchardup/postgresql
image: a4bc65fd

command 启动命令

覆盖容器启动后默认执行的命令。

command: echo "hello world"

depends_on 启动依赖

解决容器的依赖、启动先后的问题。以下例子中会先启动 redis db 再启动 web

version: '3'

services:
  web:
    build: .
    depends_on:
      - db
      - redis

  redis:
    image: redis

  db:
    image: postgres

注意：web 服务不会等待 redis db 「完全启动」之后才启动。

dns 自定义 DNS 服务器

自定义 DNS 服务器。可以是一个值，也可以是一个列表。

dns: 8.8.8.8

dns:
  - 8.8.8.8
  - 114.114.114.114

env_file 文件取得环境变量

从文件中获取环境变量，可以为单独的文件路径或列表。

如果通过 docker-compose -f FILE 方式来指定 Compose 模板文件，则 env_file 中变量的路径会基于模板文件路径。

如果有变量名称与 environment 指令冲突，则按照惯例，以后者为准。

env_file: .env

env_file:
  - ./common.env
  - ./apps/web.env
  - /opt/secrets.env

环境变量文件中每一行必须符合格式，支持 # 开头的注释行。

# env 后缀的文件
# common.env: Set development environment
PROG_ENV=development

environment 环境变量

设置环境变量。你可以使用数组或字典两种格式。

web:
  environment:
    DEBUG: 1

compose file 中的 environment 节点用来为容器设置环境变量，上面的写法等同于：

$ docker run -e DEBUG=1

只给定名称的变量会自动获取运行 Compose 主机上对应变量的值，可以用来防止泄露不必要的数据。

environment:
  RACK_ENV: development
  SESSION_SECRET:

environment:
  - RACK_ENV=development
  - SESSION_SECRET

如果变量名称或者值中用到 true|false，yes|no 等表达布尔含义的词汇，最好放到引号里，避免 YAML 自动解析某些内容为对应的布尔语义。这些特定词汇，包括

y|Y|yes|Yes|YES|n|N|no|No|NO|true|True|TRUE|false|False|FALSE|on|On|ON|off|Off|OFF

expose 暴露端口

暴露端口，但不映射到宿主机，只被连接的服务访问。

仅可以指定内部端口为参数

expose:
 - "3000"
 - "8000"

extra_hosts IP 映射

类似 Docker 中的 --add-host 参数，指定额外的 host 名称映射信息。（就是改 Host 文件）

extra_hosts:
 - "googledns:8.8.8.8"
 - "dockerhub:52.1.157.61"

会在启动后的服务容器中 /etc/hosts 文件中添加如下两条条目。

8.8.8.8 googledns
52.1.157.61 dockerhub

labels 元数据信息

为容器添加 Docker 元数据（metadata）信息。例如可以为容器添加辅助说明信息。

labels:
  com.startupteam.description: "webapp for a startup team"
  com.startupteam.department: "devops department"
  com.startupteam.release: "rc3 for v1.0"

logging 配置日志

配置日志选项。

logging:
  driver: syslog
  options:
    syslog-address: "tcp://192.168.0.42:123"

目前支持三种日志驱动类型。

driver: "json-file"
driver: "syslog"
driver: "none"

options 配置日志驱动的相关参数。

options:
  max-size: "200k"
  max-file: "10"

network_mode 指定网络模式

设置网络模式。使用和 docker run 的 --network 参数一样的值。

network_mode: "bridge"
network_mode: "host"
network_mode: "none"
network_mode: "service:[service name]"
network_mode: "container:[container name/id]"

networks 连接的网络

配置容器连接的网络。

version: "3"
services:

  some-service:
    networks:
     - some-network
     - other-network

networks:
  some-network:
  other-network:

pid 共享进程号

跟主机系统共享进程命名空间。打开该选项的容器之间，以及容器和宿主机系统之间可以通过进程 ID 来相互访问和操作。

pid: "host"

ports 暴露端口信息

使用宿主端口：容器端口 (HOST:CONTAINER) 格式，或者仅仅指定容器的端口（宿主将会随机选择端口）都可以。

ports:
 - "3000"
 - "8000:8000"
 - "49100:22"
 - "127.0.0.1:8001:8001"

注意：当使用 HOST:CONTAINER 格式来映射端口时，如果你使用的容器端口小于 60 并且没放到引号里，可能会得到错误结果，因为 YAML 会自动解析 xx:yy 这种数字格式为 60 进制。为避免出现这种问题，建议数字串都采用引号包括起来的字符串格式。

volumes 数据卷

数据卷所挂载路径设置。可以设置为宿主机路径 (HOST:CONTAINER) 或者数据卷名称 (VOLUME:CONTAINER)，并且可以设置访问模式（HOST:CONTAINER:ro）

该指令中路径支持相对路径。

volumes:
 - /var/lib/mysql
 - cache/:/tmp/cache
 - ~/configs:/etc/configs/:ro

如果路径为数据卷名称，必须在文件中配置数据卷。

version: "3"

services:
  my_src:
    image: mysql:8.0
    volumes:
      - mysql_data:/var/lib/mysql

volumes:
  mysql_data:

其它命令 ⭐

指定服务容器启动后执行的入口文件。

entrypoint: /code/entrypoint.sh

指定容器中运行应用的用户名。

user: nginx

指定容器中工作目录。

working_dir: /code

Reference ~

参考资料 Compose 模板文件参考资料 Declare default environment variables in file

安装 Docker Compose​

Docker Compose 是什​

Compose 常用命令​

模板文件示例​

取消开机自启​

常用的指令​

build 指定构建文件​

image 指定镜像​

command 启动命令​

depends_on 启动依赖​

dns 自定义 DNS 服务器​

env_file 文件取得环境变量​

environment 环境变量​

expose 暴露端口​

extra_hosts IP 映射​

labels 元数据信息​

logging 配置日志​

network_mode 指定网络模式​

networks 连接的网络​

pid 共享进程号​

ports 暴露端口信息​

volumes 数据卷​

其它命令 ⭐​

Reference ~​